<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: coe_emerg_ring.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('coe__emerg__ring_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">coe_emerg_ring.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT CoE emergency ring buffer methods.  
<a href="#details">More...</a></p>

<p><a href="coe__emerg__ring_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a47aeba0336dfc752903be4af5c7413ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#a47aeba0336dfc752903be4af5c7413ad">ec_coe_emerg_ring_init</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring, <a class="el" href="group__ApplicationInterface.html#ga81f6717d9d4157df53b863e5ee3b04a4">ec_slave_config_t</a> *sc)</td></tr>
<tr class="memdesc:a47aeba0336dfc752903be4af5c7413ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emergency ring buffer constructor.  <a href="#a47aeba0336dfc752903be4af5c7413ad">More...</a><br /></td></tr>
<tr class="separator:a47aeba0336dfc752903be4af5c7413ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7cc151e78f390fe9c3a12b73da6451d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#af7cc151e78f390fe9c3a12b73da6451d">ec_coe_emerg_ring_clear</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring)</td></tr>
<tr class="memdesc:af7cc151e78f390fe9c3a12b73da6451d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emergency ring buffer destructor.  <a href="#af7cc151e78f390fe9c3a12b73da6451d">More...</a><br /></td></tr>
<tr class="separator:af7cc151e78f390fe9c3a12b73da6451d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7cb32cfafb48b4dfeb112a6e18885af"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#af7cb32cfafb48b4dfeb112a6e18885af">ec_coe_emerg_ring_size</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring, size_t size)</td></tr>
<tr class="memdesc:af7cb32cfafb48b4dfeb112a6e18885af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the ring size.  <a href="#af7cb32cfafb48b4dfeb112a6e18885af">More...</a><br /></td></tr>
<tr class="separator:af7cb32cfafb48b4dfeb112a6e18885af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73171f530429590ca7f6ad324199c146"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#a73171f530429590ca7f6ad324199c146">ec_coe_emerg_ring_push</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring, const u8 *msg)</td></tr>
<tr class="memdesc:a73171f530429590ca7f6ad324199c146"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new emergency message.  <a href="#a73171f530429590ca7f6ad324199c146">More...</a><br /></td></tr>
<tr class="separator:a73171f530429590ca7f6ad324199c146"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2da0f9ff8bdc6435eaa9ff40ec76f69"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#ab2da0f9ff8bdc6435eaa9ff40ec76f69">ec_coe_emerg_ring_pop</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring, u8 *msg)</td></tr>
<tr class="memdesc:ab2da0f9ff8bdc6435eaa9ff40ec76f69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove an emergency message from the ring.  <a href="#ab2da0f9ff8bdc6435eaa9ff40ec76f69">More...</a><br /></td></tr>
<tr class="separator:ab2da0f9ff8bdc6435eaa9ff40ec76f69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd2793534be712998dee14e016eeef25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#acd2793534be712998dee14e016eeef25">ec_coe_emerg_ring_clear_ring</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring)</td></tr>
<tr class="memdesc:acd2793534be712998dee14e016eeef25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the ring.  <a href="#acd2793534be712998dee14e016eeef25">More...</a><br /></td></tr>
<tr class="separator:acd2793534be712998dee14e016eeef25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a2389648c819d72d008dc5e7749d359"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8c.html#a6a2389648c819d72d008dc5e7749d359">ec_coe_emerg_ring_overruns</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *ring)</td></tr>
<tr class="memdesc:a6a2389648c819d72d008dc5e7749d359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the number of overruns.  <a href="#a6a2389648c819d72d008dc5e7749d359">More...</a><br /></td></tr>
<tr class="separator:a6a2389648c819d72d008dc5e7749d359"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT CoE emergency ring buffer methods. </p>

<p class="definition">Definition in file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a47aeba0336dfc752903be4af5c7413ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47aeba0336dfc752903be4af5c7413ad">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ec_coe_emerg_ring_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__ApplicationInterface.html#ga81f6717d9d4157df53b863e5ee3b04a4">ec_slave_config_t</a> *&#160;</td>
          <td class="paramname"><em>sc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Emergency ring buffer constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">sc</td><td>Slave configuration. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00046">46</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="af7cc151e78f390fe9c3a12b73da6451d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7cc151e78f390fe9c3a12b73da6451d">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ec_coe_emerg_ring_clear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Emergency ring buffer destructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00063">63</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="af7cb32cfafb48b4dfeb112a6e18885af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7cb32cfafb48b4dfeb112a6e18885af">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_size </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the ring size. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">size</td><td>Maximum number of messages in the ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00078">78</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="a73171f530429590ca7f6ad324199c146"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73171f530429590ca7f6ad324199c146">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_push()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ec_coe_emerg_ring_push </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u8 *&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new emergency message. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">msg</td><td>Emergency message. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00113">113</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="ab2da0f9ff8bdc6435eaa9ff40ec76f69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2da0f9ff8bdc6435eaa9ff40ec76f69">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_pop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_pop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remove an emergency message from the ring. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">msg</td><td>Memory to store the emergency message. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00135">135</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="acd2793534be712998dee14e016eeef25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2793534be712998dee14e016eeef25">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_clear_ring()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_clear_ring </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clear the ring. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00155">155</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="a6a2389648c819d72d008dc5e7749d359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a2389648c819d72d008dc5e7749d359">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_overruns()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_overruns </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read the number of overruns. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of overruns. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00170">170</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="coe__emerg__ring_8c.html">coe_emerg_ring.c</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
